import java.util.Scanner;
/*********************************************************************
 * Copyright (C) 2008 by Duncan A. Buell.  All rights reserved.
 * Interface for the <code>Key</code> class.
 *
 * @author Duncan A. Buell
 * @version 1.00 2008-01-01
**/
public interface IKey
{
/*********************************************************************
 * Instance variable.
**/
//  private String key = "";

/*********************************************************************
 * Constructor.
**/
//  public Key()
//  {
//    this.key = new String("EmptyKey");
//  } // public Key()

/*********************************************************************
 * Accessors and mutators.
**/
/*********************************************************************
 * Method to get the <code>key</code>.
 *
 * @return the value of <code>key</code>.
**/
//  private String getKey();

/*********************************************************************
 * Method to set the <code>key</code>.
 *
 * @param the <code>String</code> to set as the <code>key</code>.
**/
//  private void setKey(String s);

/*********************************************************************
 * Method to set the <code>key</code>.
 *
 * @param the <code>Record</code> from which to create a
 *            <code>key</code>.
**/
  public void setKey(Record record);

/*********************************************************************
 * General methods.
**/
/*********************************************************************
 * Method to do <code>equals</code> for two keys.
 *
 * @param the <code>Key</code> to compare.
 *
 * @return the answer to the question.
**/
  public boolean equals(Key that);

/*********************************************************************
 * Method to read the <code>key</code> from a file.
 *
 * @param the <code>Scanner</code> from which to read.
**/
//  static public Key readKey(Scanner inFile);

/*********************************************************************
 * Method to toString the <code>key</code>.
 *
 * @return a <code>String</code> value of the key. 
**/
  public String toString();

} // public interface IKey
